<?php
/**
 * Nuwani PHP IRC Bot Framework
 * Copyright (c) 2006-2010 The Nuwani Project
 *
 * Nuwani is a framework for IRC Bots built using PHP. Nuwani speeds up bot 
 * development by handling basic tasks as connection- and bot management, timers
 * and module managing. Features for your bot can easily be added by creating
 * your own modules, which will receive callbacks from the framework.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @copyright Copyright (c) 2006-2011 The Nuwani Project
 * @author Peter Beverloo <peter@lvp-media.com>
 * @author Dik Grapendaal <dik.grapendaal@gmail.com>
 * @see http://nuwani.googlecode.com
 */

//namespace Nuwani;

require __DIR__ . '/IrcInput.php';

/**
 * Uno Nuwani Module
 * 
 * @copyright Copyright (c) 2011 The Nuwani Project, http://nuwani.googlecode.com/
 * @author Dik Grapendaal <dik.grapendaal@gmail.com>
 * @version $Id: UnoInput.php 141 2011-07-23 21:47:01Z dik.grapendaal $
 * @package Modules
 */

abstract class UnoInput
{
        /**
         * Reference to the engine where this class will be calling methods on.
         * 
         * @var UnoEngine
         */
        
        protected $mEngine;
        
        /**
         * Sets the reference to the UnoEngine.
         * 
         * @param UnoEngine $engine The UnoEngine.
         */
        
        public function setEngine (UnoEngine $engine)
        {
                $this -> mEngine = $engine;
        }
        
        /**
         * Parses the card input as received through the input channel and
         * returns the card info in the input as an array the Uno engine
         * understands.
         * 
         * @param string $input The input received.
         * @return array
         */
        
        abstract public function parseCardInput ($input);
}